Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't inject <br> tags into <pre> examples #52

Merged
merged 1 commit into from
Nov 18, 2022

Conversation

tillkruss
Copy link
Contributor

@tillkruss tillkruss commented Nov 13, 2022

<pre> tags shouldn't have any <br>s in them, it's the whole purpose and makes multiline examples looks really odd and spaced-out.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/pre

Copy link
Member

@williamdes williamdes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, that's a good fix

@codecov
Copy link

codecov bot commented Nov 13, 2022

Codecov Report

Base: 56.25% // Head: 56.25% // No change to project coverage 👍

Coverage data is based on head (302b7aa) compared to base (661bf7b).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff            @@
##               main      #52   +/-   ##
=========================================
  Coverage     56.25%   56.25%           
  Complexity     1236     1236           
=========================================
  Files            53       53           
  Lines          3173     3173           
=========================================
  Hits           1785     1785           
  Misses         1388     1388           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@williamdes
Copy link
Member

Can you provide a doc block that I can add to my test cases?

@williamdes williamdes added this to the v5.5.2 milestone Nov 13, 2022
@tillkruss
Copy link
Contributor Author

tillkruss commented Nov 13, 2022

Can you provide a doc block that I can add to my test cases?

I can't find any @example tests, happy to extend them.

Two @example blocks

/**
 * Elementum semper nullam primis tempus quisque tempor.
 *
 * @example $redis->copy('source1', 'newkey');
 * @example $redis->copy('source1', 'newkey', ['db' => 1]);
 */ 

Multiline @example block

/**
 * Elementum semper nullam primis tempus quisque tempor.
 *
 * @example
 * $redis->pipeline()
 *       ->select(1)
 *       ->del('newkey')
 *       ->select(0)
 *       ->del('newkey')
 *       ->mset(['source1' => 'value1', 'exists' => 'old_value'])
 *       ->exec();
 */ 

@williamdes williamdes self-assigned this Nov 18, 2022
williamdes added a commit that referenced this pull request Nov 18, 2022
williamdes added a commit that referenced this pull request Nov 18, 2022
@williamdes williamdes merged commit 19809fc into code-lts:main Nov 18, 2022
@williamdes williamdes modified the milestones: v5.6.0, v5.5.2 Mar 12, 2023
@williamdes
Copy link
Member

Moved to v5.5.2 to be released today 🎉
5.6.0 will wait because of #51

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants